package cn.bonoon.kernel.web.annotations.form;

import static java.lang.annotation.ElementType.FIELD;
import static java.lang.annotation.RetentionPolicy.RUNTIME;

import java.lang.annotation.Retention;
import java.lang.annotation.Target;

/**
 * <pre>
 * 在明细项的后面增加帮助说明，添加、修改、查看都可以使用本注解进行说明
 * 可以一起使用的注解包括：
 * {@link PropertyDetail}
 * {@link PropertyEditor}
 * {@link PropertyInsert}
 * {@link PropertyUpdate}
 * <hr/>
 * 如果需要在整个界面上使用帮助说明的，可以使用{@link FormHelper}
 * </pre>
 * @author jackson
 * 
 */
@Target(FIELD)
@Retention(RUNTIME)
public @interface PropertyHelper {
	/**
	 * 帮助提示的内容
	 * 
	 * @return
	 */
	String value();

	String image() default "";

	String name() default "帮助";

	HelperType type() default HelperType.PROMPT;
	public enum HelperType {

		/**
		 * 在a标签的title里，当鼠标移动标签上，显示帮助内容
		 */
		PROMPT,

		/**
		 * 把value的内容直接放到界面上来显示
		 */
		DIRECT,

		/**
		 * 用来指明value值是否是一个url，如果是，则使用ajax动态请求数据库
		 */
		URL,

		/**
		 * 用来指定value值是否去加载一个div或其它组件来显示帮助信息的内容
		 */
		LOAD,
		/**
		 * 帮助文字另起一行
		 */
		WRAP
	}
}
